/*
 ***************************************************************************************
 *  Copyright (C) 2006 EsperTech, Inc. All rights reserved.                            *
 *  http://www.espertech.com/esper                                                     *
 *  http://www.espertech.com                                                           *
 *  ---------------------------------------------------------------------------------- *
 *  The software in this package is published under the terms of the GPL license       *
 *  a copy of which has been included with this distribution in the license.txt file.  *
 ***************************************************************************************
 */
package com.espertech.esper.common.client.soda;

/**
 * Unit for output rate limiting.
 */
public enum OutputLimitUnit {
    /**
     * The time period unit.
     */
    TIME_PERIOD("timeperiod"),

    /**
     * The number of events unit.
     */
    EVENTS("events"),

    /**
     * The unit representing a when-expression.
     */
    WHEN_EXPRESSION("when"),

    /**
     * The unit representing a crontab-at-expression.
     */
    CRONTAB_EXPRESSION("crontab"),

    /**
     * The unit representing just after a time period or after a number of events.
     */
    AFTER("after"),

    /**
     * The unit representing that output occurs when the context partition terminates.
     */
    CONTEXT_PARTITION_TERM("when terminated");

    private String text;

    private OutputLimitUnit(String text) {
        this.text = text;
    }

    /**
     * Returns the text for the unit.
     *
     * @return unit text
     */
    public String getText() {
        return text;
    }
}
